home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1997 April: Mac OS SDK / Dev.CD Apr 97 SDK1.toast / Development Kits (Disc 1) / Interfaces&Libraries / Interfaces / PInterfaces / AppleGuide.p < prev    next >
Encoding:
Text File  |  1996-05-31  |  9.3 KB  |  345 lines  |  [TEXT/MPS ]
  1. {
  2.      File:        AppleGuide.p
  3.  
  4.      Contains:    Apple Guide Interfaces.
  5.  
  6.      Version:    Technology:    System 7.5
  7.                  Package:    Universal Interfaces 2.1.3
  8.  
  9.      Copyright:    © 1984-1996 by Apple Computer, Inc.
  10.                  All rights reserved.
  11.  
  12.      Bugs?:        If you find a problem with this file, use the Apple Bug Reporter
  13.                  stack.  Include the file and version information (from above)
  14.                  in the problem description and send to:
  15.                      Internet:    apple.bugs@applelink.apple.com
  16.                      AppleLink:    APPLE.BUGS
  17.  
  18. }
  19.  
  20. {$IFC UNDEFINED UsingIncludes}
  21. {$SETC UsingIncludes := 0}
  22. {$ENDC}
  23.  
  24. {$IFC NOT UsingIncludes}
  25.  UNIT AppleGuide;
  26.  INTERFACE
  27. {$ENDC}
  28.  
  29. {$IFC UNDEFINED __APPLEGUIDE__}
  30. {$SETC __APPLEGUIDE__ := 1}
  31.  
  32. {$I+}
  33. {$SETC AppleGuideIncludes := UsingIncludes}
  34. {$SETC UsingIncludes := 1}
  35.  
  36.  
  37. {$IFC UNDEFINED __APPLEEVENTS__}
  38. {$I AppleEvents.p}
  39. {$ENDC}
  40. {    Errors.p                                                    }
  41. {        ConditionalMacros.p                                        }
  42. {    Types.p                                                        }
  43. {    Memory.p                                                    }
  44. {        MixedMode.p                                                }
  45. {    OSUtils.p                                                    }
  46. {    Events.p                                                    }
  47. {        Quickdraw.p                                                }
  48. {            QuickdrawText.p                                        }
  49. {    EPPC.p                                                        }
  50. {        AppleTalk.p                                                }
  51. {        Files.p                                                    }
  52. {            Finder.p                                            }
  53. {        PPCToolbox.p                                            }
  54. {        Processes.p                                                }
  55. {    Notification.p                                                }
  56.  
  57. {$IFC UNDEFINED __FILES__}
  58. {$I Files.p}
  59. {$ENDC}
  60.  
  61. {$IFC UNDEFINED __TYPES__}
  62. {$I Types.p}
  63. {$ENDC}
  64.  
  65. {$PUSH}
  66. {$ALIGN MAC68K}
  67. {$LibExport+}
  68.     
  69. TYPE
  70.     AGRefNum = UInt32;
  71.  
  72.     AGCoachRefNum = UInt32;
  73.  
  74.     AGContextRefNum = UInt32;
  75.  
  76.     AGAppInfo = RECORD
  77.         eventId:                AEEventID;
  78.         refCon:                    LONGINT;
  79.         contextObj:                Ptr;                                    { private system field}
  80.     END;
  81.  
  82.     AGAppInfoPtr = ^AGAppInfo;
  83.     AGAppInfoHdl = ^AGAppInfoPtr;
  84.  
  85.     CoachReplyProcPtr = ProcPtr;  { FUNCTION CoachReply(VAR pRect: Rect; name: Ptr; refCon: LONGINT): OSErr; }
  86.     ContextReplyProcPtr = ProcPtr;  { FUNCTION ContextReply(pInputData: Ptr; inputDataSize: Size; VAR ppOutputData: Ptr; VAR pOutputDataSize: Size; hAppInfo: AGAppInfoHdl): OSErr; }
  87.     CoachReplyUPP = UniversalProcPtr;
  88.     ContextReplyUPP = UniversalProcPtr;
  89.  
  90. CONST
  91.     uppCoachReplyProcInfo = $00000FE0; { FUNCTION (4 byte param, 4 byte param, 4 byte param): 2 byte result; }
  92.     uppContextReplyProcInfo = $0000FFE0; { FUNCTION (4 byte param, 4 byte param, 4 byte param, 4 byte param, 4 byte param): 2 byte result; }
  93.  
  94. FUNCTION NewCoachReplyProc(userRoutine: CoachReplyProcPtr): CoachReplyUPP;
  95.     {$IFC NOT GENERATINGCFM }
  96.     INLINE $2E9F;
  97.     {$ENDC}
  98.  
  99. FUNCTION NewContextReplyProc(userRoutine: ContextReplyProcPtr): ContextReplyUPP;
  100.     {$IFC NOT GENERATINGCFM }
  101.     INLINE $2E9F;
  102.     {$ENDC}
  103.  
  104. FUNCTION CallCoachReplyProc(VAR pRect: Rect; name: Ptr; refCon: LONGINT; userRoutine: CoachReplyUPP): OSErr;
  105.     {$IFC NOT GENERATINGCFM}
  106.     INLINE $205F, $4E90;
  107.     {$ENDC}
  108.  
  109. FUNCTION CallContextReplyProc(pInputData: Ptr; inputDataSize: Size; VAR ppOutputData: Ptr; VAR pOutputDataSize: Size; hAppInfo: AGAppInfoHdl; userRoutine: ContextReplyUPP): OSErr;
  110.     {$IFC NOT GENERATINGCFM}
  111.     INLINE $205F, $4E90;
  112.     {$ENDC}
  113.  
  114. CONST
  115.     gestaltAppleGuidePresent    = 31;
  116.     gestaltAppleGuideIsDebug    = 30;
  117.     kAGDefault                    = 0;
  118.     kAGFrontDatabase            = 1;
  119.     kAGNoMixin                    = 0+(-1);
  120.  
  121.     kAGViewFullHowdy            = 1;                            { Full-size Howdy}
  122.     kAGViewTopicAreas            = 2;                            { Full-size Topic Areas}
  123.     kAGViewIndex                = 3;                            { Full-size Index Terms}
  124.     kAGViewLookFor                = 4;                            { Full-size Look-For (Search)}
  125.     kAGViewSingleHowdy            = 5;                            { Single-list-size Howdy}
  126.     kAGViewSingleTopics            = 6;                            { Single-list-size Topics}
  127.  
  128.     kAGFileMain                    = 'poco';
  129.     kAGFileMixin                = 'mixn';
  130.  
  131. { To test against AGGetAvailableDBTypes}
  132.     kAGDBTypeBitAny                = $00000001;
  133.     kAGDBTypeBitHelp            = $00000002;
  134.     kAGDBTypeBitTutorial        = $00000004;
  135.     kAGDBTypeBitShortcuts        = $00000008;
  136.     kAGDBTypeBitAbout            = $00000010;
  137.     kAGDBTypeBitOther            = $00000080;
  138.  
  139.     
  140. TYPE
  141.     AGStatus = UInt16;
  142.  
  143. { Returned by AGGetStatus}
  144.  
  145. CONST
  146.     kAGIsNotRunning                = 0;
  147.     kAGIsSleeping                = 1;
  148.     kAGIsActive                    = 2;
  149.  
  150.     
  151. TYPE
  152.     AGWindowKind = UInt16;
  153.  
  154. { Returned by AGGetFrontWindowKind}
  155.  
  156. CONST
  157.     kAGNoWindow                    = 0;
  158.     kAGAccessWindow                = 1;
  159.     kAGPresentationWindow        = 2;
  160.  
  161. { Error Codes}
  162. { Not an enum, because other OSErrs are valid.}
  163.     
  164. TYPE
  165.     AGErr = SInt16;
  166.  
  167. { Apple Guide error codes}
  168.  
  169. CONST
  170. { -------------------- Apple event reply codes}
  171.     kAGErrUnknownEvent            = -2900;
  172.     kAGErrCantStartup            = -2901;
  173.     kAGErrNoAccWin                = -2902;
  174.     kAGErrNoPreWin                = -2903;
  175.     kAGErrNoSequence            = -2904;
  176.     kAGErrNotOopsSequence        = -2905;
  177.     kAGErrReserved06            = -2906;
  178.     kAGErrNoPanel                = -2907;
  179.     kAGErrContentNotFound        = -2908;
  180.     kAGErrMissingString            = -2909;
  181.     kAGErrInfoNotAvail            = -2910;
  182.     kAGErrEventNotAvailable        = -2911;
  183.     kAGErrCannotMakeCoach        = -2912;
  184.     kAGErrSessionIDsNotMatch    = -2913;
  185.     kAGErrMissingDatabaseSpec    = -2914;
  186. { -------------------- Coach's Chalkboard reply codes}
  187.     kAGErrItemNotFound            = -2925;
  188.     kAGErrBalloonResourceNotFound = -2926;
  189.     kAGErrChalkResourceNotFound    = -2927;
  190.     kAGErrChdvResourceNotFound    = -2928;
  191.     kAGErrAlreadyShowing        = -2929;
  192.     kAGErrBalloonResourceSkip    = -2930;
  193.     kAGErrItemNotVisible        = -2931;
  194.     kAGErrReserved32            = -2932;
  195.     kAGErrNotFrontProcess        = -2933;
  196.     kAGErrMacroResourceNotFound    = -2934;
  197. { -------------------- API reply codes}
  198.     kAGErrAppleGuideNotAvailable = -2951;
  199.     kAGErrCannotInitCoach        = -2952;
  200.     kAGErrCannotInitContext        = -2953;
  201.     kAGErrCannotOpenAliasFile    = -2954;
  202.     kAGErrNoAliasResource        = -2955;
  203.     kAGErrDatabaseNotAvailable    = -2956;
  204.     kAGErrDatabaseNotOpen        = -2957;
  205.     kAGErrMissingAppInfoHdl        = -2958;
  206.     kAGErrMissingContextObject    = -2959;
  207.     kAGErrInvalidRefNum            = -2960;
  208.     kAGErrDatabaseOpen            = -2961;
  209.     kAGErrInsufficientMemory    = -2962;
  210.  
  211. { Events}
  212. { Not an enum because we want to make assignments.}
  213.     
  214. TYPE
  215.     AGEvent = UInt32;
  216.  
  217. { Handy events for AGGeneral.}
  218.  
  219. CONST
  220. { Panel actions (Require a presentation window).}
  221.     kAGEventDoCoach                = 'doco';
  222.     kAGEventDoHuh                = 'dhuh';
  223.     kAGEventGoNext                = 'gonp';
  224.     kAGEventGoPrev                = 'gopp';
  225.     kAGEventHidePanel            = 'pahi';
  226.     kAGEventReturnBack            = 'gobk';
  227.     kAGEventShowPanel            = 'pash';
  228.     kAGEventTogglePanel            = 'patg';
  229.  
  230. { Functions}
  231. { AGClose}
  232. { Close the database associated with the AGRefNum.}
  233.  
  234. FUNCTION AGClose(VAR refNum: AGRefNum): AGErr;
  235.     {$IFC NOT GENERATINGCFM}
  236.     INLINE $7011, $AA6E;
  237.     {$ENDC}
  238. { AGGeneral}
  239. { Cause various events to happen.}
  240. FUNCTION AGGeneral(refNum: AGRefNum; theEvent: AGEvent): AGErr;
  241.     {$IFC NOT GENERATINGCFM}
  242.     INLINE $700D, $AA6E;
  243.     {$ENDC}
  244. { AGGetAvailableDBTypes}
  245. { Return the database types available for this application.}
  246. FUNCTION AGGetAvailableDBTypes: UInt32;
  247.     {$IFC NOT GENERATINGCFM}
  248.     INLINE $7008, $AA6E;
  249.     {$ENDC}
  250. { AGGetFrontWindowKind}
  251. { Return the kind of the front window.}
  252. FUNCTION AGGetFrontWindowKind(refNum: AGRefNum): AGWindowKind;
  253.     {$IFC NOT GENERATINGCFM}
  254.     INLINE $700C, $AA6E;
  255.     {$ENDC}
  256. { AGGetFSSpec}
  257. { Return the FSSpec for the AGRefNum.}
  258. FUNCTION AGGetFSSpec(refNum: AGRefNum; fileSpec: ConstFSSpecPtr): AGErr;
  259.     {$IFC NOT GENERATINGCFM}
  260.     INLINE $700F, $AA6E;
  261.     {$ENDC}
  262. { AGGetStatus}
  263. { Return the status of Apple Guide.}
  264. FUNCTION AGGetStatus: AGStatus;
  265.     {$IFC NOT GENERATINGCFM}
  266.     INLINE $7009, $AA6E;
  267.     {$ENDC}
  268. { AGInstallCoachHandler}
  269. { Install a Coach object location query handler.}
  270. FUNCTION AGInstallCoachHandler(coachReplyProc: CoachReplyUPP; refCon: LONGINT; VAR resultRefNum: AGCoachRefNum): AGErr;
  271.     {$IFC NOT GENERATINGCFM}
  272.     INLINE $7012, $AA6E;
  273.     {$ENDC}
  274. { AGInstallContextHandler}
  275. { Install a context check query handler.}
  276. FUNCTION AGInstallContextHandler(contextReplyProc: ContextReplyUPP; eventID: AEEventID; refCon: LONGINT; VAR resultRefNum: AGContextRefNum): AGErr;
  277.     {$IFC NOT GENERATINGCFM}
  278.     INLINE $7013, $AA6E;
  279.     {$ENDC}
  280. { AGIsDatabaseOpen}
  281. { Return true if the database associated with the AGRefNum is open.}
  282. FUNCTION AGIsDatabaseOpen(refNum: AGRefNum): BOOLEAN;
  283.     {$IFC NOT GENERATINGCFM}
  284.     INLINE $7006, $AA6E;
  285.     {$ENDC}
  286. { AGOpen}
  287. { Open a guide database.}
  288. FUNCTION AGOpen(fileSpec: ConstFSSpecPtr; flags: UInt32; mixinControl: Handle; VAR resultRefNum: AGRefNum): AGErr;
  289.     {$IFC NOT GENERATINGCFM}
  290.     INLINE $7001, $AA6E;
  291.     {$ENDC}
  292. { AGOpenWithSearch}
  293. { Open a guide database and preset a search string.}
  294. FUNCTION AGOpenWithSearch(fileSpec: ConstFSSpecPtr; flags: UInt32; mixinControl: Handle; searchString: ConstStr255Param; VAR resultRefNum: AGRefNum): AGErr;
  295.     {$IFC NOT GENERATINGCFM}
  296.     INLINE $7002, $AA6E;
  297.     {$ENDC}
  298. { AGOpenWithSequence}
  299. { Open a guide database and display a presentation window sequence.}
  300. FUNCTION AGOpenWithSequence(fileSpec: ConstFSSpecPtr; flags: UInt32; mixinControl: Handle; sequenceID: INTEGER; VAR resultRefNum: AGRefNum): AGErr;
  301.     {$IFC NOT GENERATINGCFM}
  302.     INLINE $7004, $AA6E;
  303.     {$ENDC}
  304. { AGOpenWithView}
  305. { Open a guide database and override the default view.}
  306. FUNCTION AGOpenWithView(fileSpec: ConstFSSpecPtr; flags: UInt32; mixinControl: Handle; viewNum: INTEGER; VAR resultRefNum: AGRefNum): AGErr;
  307.     {$IFC NOT GENERATINGCFM}
  308.     INLINE $7005, $AA6E;
  309.     {$ENDC}
  310. { AGQuit}
  311. { Make Apple Guide quit.}
  312. FUNCTION AGQuit: AGErr;
  313.     {$IFC NOT GENERATINGCFM}
  314.     INLINE $7010, $AA6E;
  315.     {$ENDC}
  316. { AGRemoveCoachHandler}
  317. { Remove the Coach object location query handler.}
  318. FUNCTION AGRemoveCoachHandler(VAR resultRefNum: AGCoachRefNum): AGErr;
  319.     {$IFC NOT GENERATINGCFM}
  320.     INLINE $7014, $AA6E;
  321.     {$ENDC}
  322. { AGRemoveContextHandler}
  323. { Remove the context check query handler.}
  324. FUNCTION AGRemoveContextHandler(VAR resultRefNum: AGContextRefNum): AGErr;
  325.     {$IFC NOT GENERATINGCFM}
  326.     INLINE $7015, $AA6E;
  327.     {$ENDC}
  328. { AGStart}
  329. { Start up Apple Guide in the background.}
  330. FUNCTION AGStart: AGErr;
  331.     {$IFC NOT GENERATINGCFM}
  332.     INLINE $700A, $AA6E;
  333.     {$ENDC}
  334.  
  335. {$ALIGN RESET}
  336. {$POP}
  337.  
  338. {$SETC UsingIncludes := AppleGuideIncludes}
  339.  
  340. {$ENDC} {__APPLEGUIDE__}
  341.  
  342. {$IFC NOT UsingIncludes}
  343.  END.
  344. {$ENDC}
  345.